Skip to content

Fixed TypeDoc generation in PBU#1927

Merged
tjcouch-sil merged 1 commit into
mainfrom
2358-fix-tsdocs
Nov 21, 2025
Merged

Fixed TypeDoc generation in PBU#1927
tjcouch-sil merged 1 commit into
mainfrom
2358-fix-tsdocs

Conversation

@tjcouch-sil

@tjcouch-sil tjcouch-sil commented Nov 20, 2025

Copy link
Copy Markdown
Member

TypeDoc documentation build failure: https://github.com/paranext/paranext-core/actions/runs/19511634364/job/55852599399

Added XML as a language it can generate docs for (the others I put in the list are default, but I can't mention that in a comment because typedoc.json is JSON :/ ). No idea why it doesn't just allow all whose grammar it knows. Also ignored USFM so it doesn't throw a bunch of warnings that it doesn't know that grammar. Also no idea why it warns on USFM but errors on XML.

Corresponding PR in usfm-tools to fix some smaller warnings: paranext/usfm-tools#2


This change is Reviewable

@jolierabideau jolierabideau left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typedoc can be so frustrating, thanks for working on this!

@jolierabideau reviewed 9 of 9 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@tjcouch-sil tjcouch-sil merged commit 6f21eba into main Nov 21, 2025
7 checks passed
@tjcouch-sil tjcouch-sil deleted the 2358-fix-tsdocs branch November 21, 2025 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants